Skip to content

Add Cursor rules to improve Cursor support for development #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 47 commits into from
Jun 13, 2025

Conversation

yczhang-nv
Copy link
Contributor

@yczhang-nv yczhang-nv commented May 27, 2025

Description

  • Implemented structured Cursor rules that guide Cursor Chat Agent through specific development scenarios, promoting consistency and accuracy in automated responses

  • Researched and defined best practices for Cursor rules implementation within this codebase

  • Added documentation for both users and developers interacting with Cursor rules.

    • Tutorial for End Users: build-a-demo-agent-workflow-using-cursor-rules.md - Demonstrates how Cursor rules enhance learning, development, and testing of AIQ workflows through hands-on examples
    • Implementation Guide for Contributors:cursor-rules-developer-guide.md - Details the organizational framework of Cursor rules and provides guidelines for creating and maintaining them
    • Complete Reference Manual: cursor-rules-reference.md - Comprehensive catalog of all available Cursor rules and their functionalities

Official documentation of Cursor rules: Rules

Closes AIQ-1353

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

@yczhang-nv yczhang-nv self-assigned this May 27, 2025
@yczhang-nv yczhang-nv added feature request New feature or request non-breaking Non-breaking change labels May 27, 2025
@yczhang-nv yczhang-nv changed the title Yuchen add cursor rules Add cursor rules to improve Cursor support for AIQ development May 27, 2025
yczhang-nv added 20 commits May 27, 2025 17:00
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
@yczhang-nv yczhang-nv marked this pull request as ready for review June 11, 2025 00:49
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
@yczhang-nv yczhang-nv changed the title Add cursor rules to improve Cursor support for AIQ development Add Cursor rules to improve Cursor support for development Jun 11, 2025
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Copy link

@lvojtku lvojtku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs themselves are well-written but the cursor rules tutorial needs to be reorganized. Will meet to discuss more.

Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
Signed-off-by: Yuchen Zhang <[email protected]>
@yczhang-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 3106563 into NVIDIA:develop Jun 13, 2025
12 checks passed
@yczhang-nv yczhang-nv deleted the yuchen-add-cursor-rules branch June 16, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants